GET Audios

Overview

---

The following table contains information about the GET method for managing the proccess of retrieving all audios as a list.

GET Audios
Method	GET
URL or Endpoint	/api/v1/projectId/audios
Headers	Authorization
Parameters	projectId, search, order, insertedDate, page, take, folderId, folderview, onlyReady, onlyPublishedAudios, key, value
Body	Not Applicable

The description of the URL parameter is as follows:

projectId Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
folderId	No	integer($int32)	Unique identifier of the folder
folderView	No	bool	Indicates wether the folder is enabled for viewing
onlyReady	No	bool	Includes only audios that have status ready
onlyPublishedAudios	No	bool	Inludes only audios that are published
key	No	string	Audio key
value	No	string	Value of the audio key
search	No	string	Search a specific audio
order	No	string	Specifies the sorting order.
insertedDate	No	string($date-time)	Date when the audio was inserted.
page	No	integer($int32)	A specific page with audios.
take	No	integer($int32)	Number of audios to take.

Request Body

The GET method doesn't contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "currentPage": 1,
    "totalPages": 8,
    "pageSize": 10,
    "totalCount": 72,
    "items": [
      {
        "title": "{title}",
        "publicId": "{audioId}",
        "author": "{author}",
        "audioAuthor": "{audioAuthor}",
        "status": "Ready",
        "publishDate": "2024-03-05T22:35:00",
        "canEmbed": true,
        "thumbnail": null,
        "duration": 15.072653,
        "folderId": null,
        "folder": null,
        "progress": 0,
        "estimatedFinishTime": "",
        "showEncodingProgress": false,
        "errorId": null,
        "error": null,
        "highlight": {}
      }
    ]
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false
errors	array[string]	Indicates if there was an error
messages	array[string]	Returns the response message from back-end
result	array[Object]	Returns the response object
currentPage	integer($int32)	Number of the current page
totalPages	integer($int32)	Number of the total page
pageSize	integer($int32)	The size of the page
totalCount	integer($int32)	Number of the total records
items	array[string]	Array with records
title	string	Title of the audio
publicId	string	Unique identifier of the audio
author	string	Author of the audio
audioAuthor	string	Author of the audio content
status	string	Status of the audio
publishDate	string	Publish date of the audio
canEmbed	boolean	Indicates if the audio can be embedded
thumbnail	string	Thumbnail of the audio
duration	double	Duration of the audio in seconds
folderId	integer($int32)	Identifier of the folder
folder	string	Folder details
progress	double	Progress of the audio processing
estimatedFinishTime	string	Estimated finish time for processing
showEncodingProgress	boolean	Indicates if encoding progress should be shown
errorId	integer($int32)	Unique identifier for the error
error	string	Description of the error
highlight	object	Highlight information
resultInfo	string	Returns extra information about the result
statusCode	integer($int32)	Returns the HTTP Status Code

info

For more information about the possible errorId and error values, see Error Codes.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed